Creates an instance of Cluster.
Get the number of commands queued in automatic pipelines.
This is not available (and returns 0) until the cluster is connected and slots information have been received.
Lists the ACL categories, or the commands inside a category.
Deletes ACL users, and terminates their connections.
Simulates the execution of a command by a user, without executing the command.
Generates a pseudorandom, secure password that can be used to identify ACL users.
Lists the ACL rules of a user.
Returns helpful text about the different subcommands.
Dumps the effective rules in ACL file format.
Reloads the rules from the configured ACL file.
Lists recent security events generated due to ACL rules.
Saves the effective ACL rules in the configured ACL file.
Creates and modifies an ACL user and its rules.
Lists all ACL users.
Returns the authenticated username of the current connection.
Create add builtin command
Appends a string to the value of a key. Creates the key if it doesn't exist.
Signals that a cluster client is following an -ASK redirect.
Authenticates the connection.
Asynchronously rewrites the append-only file to disk.
Asynchronously saves the database(s) to disk.
Counts the number of set bits (population counting) in a string.
Performs arbitrary bitfield integer operations on strings.
Performs arbitrary read-only bitfield integer operations on strings.
Performs bitwise operations on multiple strings, and stores the result.
Finds the first set (1) or clear (0) bit in a string.
Pops an element from a list, pushes it to another list and returns it. Blocks until an element is available otherwise. Deletes the list if the last element was moved.
Pops the first element from one of multiple lists. Blocks until an element is available otherwise. Deletes the list if the last element was popped.
Removes and returns the first element in a list. Blocks until an element is available otherwise. Deletes the list if the last element was popped.
Removes and returns the last element in a list. Blocks until an element is available otherwise. Deletes the list if the last element was popped.
Pops an element from a list, pushes it to another list and returns it. Block until an element is available otherwise. Deletes the list if the last element was popped.
Removes and returns a member by score from one or more sorted sets. Blocks until a member is available otherwise. Deletes the sorted set if the last element was popped.
Removes and returns the member with the highest score from one or more sorted sets. Blocks until a member available otherwise. Deletes the sorted set if the last element was popped.
Removes and returns the member with the lowest score from one or more sorted sets. Blocks until a member is available otherwise. Deletes the sorted set if the last element was popped.
Call arbitrary commands.
redis.call('set', 'foo', 'bar') is the same as redis.set('foo', 'bar'),
so the only case you need to use this method is when the command is not
supported by ioredis.
redis.call('set', 'foo', 'bar');
redis.call('get', 'foo', (err, value) => {
// value === 'bar'
});
Instructs the server whether to track the keys in the next request.
A client claims its capability.
Returns the name of the connection.
Returns the client ID to which the connection's tracking notifications are redirected.
Returns helpful text about the different subcommands.
Returns the unique client ID of the connection.
Returns information about the connection.
Terminates open connections.
Lists open connections.
Sets the client eviction mode of the connection.
Controls whether commands sent by the client affect the LRU/LFU of accessed keys.
Suspends commands processing.
Instructs the server whether to reply to commands.
Sets information specific to the client or connection.
Sets the connection name.
Controls server-assisted client-side caching for the connection.
Returns information about server-assisted client-side caching for the connection.
Unblocks a client blocked by a blocking command from a different connection.
Resumes processing commands from paused clients.
Assigns new hash slots to a node.
Assigns new hash slot ranges to a node.
Advances the cluster config epoch.
Returns the number of active failure reports active for a node.
Returns the number of keys in a hash slot.
Sets hash slots as unbound for a node.
Sets hash slot ranges as unbound for a node.
Forces a replica to perform a manual failover of its primary.
Deletes all slots information from a node.
Removes a node from the nodes table.
Returns the key names in a hash slot.
Returns helpful text about the different subcommands.
Returns information about the state of a node.
Returns the hash slot for a key.
Returns a list of all TCP links to and from peer nodes.
Forces a node to handshake with another node.
Returns the ID of a node.
Returns the shard ID of a node.
Returns the cluster configuration for a node.
Lists the replica nodes of a primary node.
Configure a node as replica of a primary node.
Resets a node.
Forces a node to save the cluster configuration to disk.
Sets the configuration epoch for a new node.
Binds a hash slot to a node.
Returns the mapping of cluster slots to shards.
Lists the replica nodes of a primary node.
Return an array of slot usage statistics for slots assigned to the current node.
Returns the mapping of cluster slots to nodes.
Returns a count of commands.
Returns documentary information about one, multiple or all commands.
Extracts the key names from an arbitrary command.
Extracts the key names and access flags for an arbitrary command.
Returns helpful text about the different subcommands.
Returns information about one, multiple or all commands.
Returns a list of command names.
Returns the effective values of configuration parameters.
Returns helpful text about the different subcommands.
Resets the server's statistics.
Persists the effective configuration to file.
Sets configuration parameters in-flight.
Connect to a cluster
Copies the value of a key to a new key.
Create a builtin command
Returns the number of keys in the database.
A container for debugging commands.
Decrements the integer value of a key by one. Uses 0 as initial value if the key doesn't exist.
Decrements a number from the integer value of a key. Uses 0 as initial value if the key doesn't exist.
Define a custom command using lua script
Deletes one or more keys.
Discards a transaction.
Disconnect from every node in the cluster.
Returns a serialized representation of the value stored at a key.
Create a new instance with the same startup nodes and options as the current one.
Returns the given string.
Executes a server-side Lua script.
Executes a read-only server-side Lua script.
Executes a server-side Lua script by SHA1 digest.
Executes a read-only server-side Lua script by SHA1 digest.
Executes all commands in a transaction.
Determines whether one or more keys exist.
Sets the expiration time of a key in seconds.
Sets the expiration time of a key to a Unix timestamp.
Returns the expiration time of a key as a Unix timestamp.
Starts a coordinated failover from a server to one of its replicas.
Invokes a function.
Invokes a read-only function.
Removes all keys from all databases.
Remove all keys from the current database.
Adds one or more members to a geospatial index. The key is created if it doesn't exist.
Returns the distance between two members of a geospatial index.
Returns members from a geospatial index as geohash strings.
Returns the longitude and latitude of members from a geospatial index.
Queries a geospatial index for members within a distance from a coordinate, optionally stores the result.
Returns members from a geospatial index that are within a distance from a coordinate.
Queries a geospatial index for members within a distance from a member, optionally stores the result.
Returns members from a geospatial index that are within a distance from a member.
Queries a geospatial index for members inside an area of a box or a circle.
Queries a geospatial index for members inside an area of a box or a circle, optionally stores the result.
Returns the string value of a key.
Return supported builtin commands
Returns a bit value by offset.
Returns the string value of a key after deleting the key.
Returns the string value of a key after setting its expiration time.
Returns a substring of the string stored at a key.
Returns the previous string value of a key after setting it to a new value.
Deletes one or more fields and their values from a hash. Deletes the hash if no fields remain.
Handshakes with the server.
Determines whether a field exists in a hash.
Returns the value of a field in a hash.
Returns all fields and values in a hash.
Increments the integer value of a field in a hash by a number. Uses 0 as initial value if the field doesn't exist.
Increments the floating point value of a field by a number. Uses 0 as initial value if the field doesn't exist.
Returns all fields in a hash.
Returns the number of fields in a hash.
Returns the values of all fields in a hash.
Sets the values of multiple fields.
Returns one or more random fields from a hash.
Iterates over fields and values of a hash.
Creates or modifies the value of a field in a hash.
Sets the value of a field in a hash only when the field doesn't exist.
Returns the length of the value of a field.
Returns all values in a hash.
Increments the integer value of a key by one. Uses 0 as initial value if the key doesn't exist.
Increments the integer value of a key by a number. Uses 0 as initial value if the key doesn't exist.
Increment the floating point value of a key by a number. Uses 0 as initial value if the key doesn't exist.
Returns information and statistics about the server.
Returns all key names that match a pattern.
Returns the Unix timestamp of the last successful save to disk.
Returns a human-readable latency analysis report.
Returns a latency graph for an event.
Returns helpful text about the different subcommands.
Returns the cumulative distribution of latencies of a subset or all commands.
Returns timestamp-latency samples for an event.
Returns the latest latency samples for all events.
Resets the latency data for one or more events.
Finds the longest common substring.
Returns an element from a list by its index.
Inserts an element before or after another element in a list.
Returns the length of a list.
Returns an element after popping it from one list and pushing it to another. Deletes the list if the last element was moved.
Returns multiple elements from a list after removing them. Deletes the list if the last element was popped.
Displays computer art and the server version
Returns the first elements in a list after removing it. Deletes the list if the last element was popped.
Returns the index of matching elements in a list.
Prepends one or more elements to a list. Creates the key if it doesn't exist.
Prepends one or more elements to a list only when the list exists.
Returns a range of elements from a list.
Removes elements from a list. Deletes the list if the last element was removed.
Sets the value of an element in a list by its index.
Removes elements from both ends a list. Deletes the list if all elements were trimmed.
Outputs a memory problems report.
Returns helpful text about the different subcommands.
Returns the allocator statistics.
Asks the allocator to release memory.
Returns details about memory usage.
Estimates the memory usage of a key.
Atomically returns the string values of one or more keys.
Atomically transfers a key from one instance to another.
Returns helpful text about the different subcommands.
Returns all loaded modules.
Loads a module.
Loads a module using extended parameters.
Unloads a module.
Moves a key to another database.
Atomically creates or modifies the string values of one or more keys.
Atomically modifies the string values of one or more keys only when all keys don't exist.
Returns the internal encoding of an object.
Returns the logarithmic access frequency counter of an object.
Returns helpful text about the different subcommands.
Returns the time since the last access to an object.
Returns the reference count of a value of a key.
Removes the expiration time of a key.
Sets the expiration time of a key in milliseconds.
Sets the expiration time of a key to a Unix milliseconds timestamp.
Returns the expiration time of a key as a Unix milliseconds timestamp.
Adds elements to a HyperLogLog key. Creates the key if it doesn't exist.
Returns the approximated cardinality of the set(s) observed by the HyperLogLog key(s).
Internal commands for debugging HyperLogLog values.
Merges one or more HyperLogLog values into a single key.
An internal command for testing HyperLogLog values.
Returns the server's liveliness response.
Sets both string value and expiration time in milliseconds of a key. The key is created if it doesn't exist.
Listens for messages published to channels that match one or more patterns.
An internal command used in replication.
Returns the expiration time in milliseconds of a key.
Posts a message to a channel.
Returns the active channels.
Returns helpful text about the different subcommands.
Returns a count of unique pattern subscriptions.
Returns a count of subscribers to channels.
Returns the active shard channels.
Returns the count of subscribers of shard channels.
Stops listening to messages published to channels that match one or more patterns.
Quit the cluster gracefully.
Returns a random key name from the database.
Enables read-only queries for a connection to a Valkey replica node.
Enables read-write queries for a connection to a Valkey replica node.
An internal command for configuring the replication stream.
Configures a server as replica of another, or promotes it to a primary.
Resets the connection.
Creates a key from the serialized representation of a value.
An internal command for migrating keys in a cluster.
Returns the replication role.
Returns and removes the last elements of a list. Deletes the list if the last element was popped.
Appends one or more elements to a list. Creates the key if it doesn't exist.
Appends an element to a list only when the list exists.
Adds one or more members to a set. Creates the key if it doesn't exist.
Synchronously saves the database(s) to disk.
Iterates over the key names in the database.
Returns the number of members in a set.
Sets the debug mode of server-side Lua scripts.
Determines whether server-side Lua scripts exist in the script cache.
Removes all server-side Lua scripts from the script cache.
Returns helpful text about the different subcommands.
Terminates a server-side Lua script during execution.
Loads a server-side Lua script to the script cache.
Show server-side Lua script in the script cache.
Returns the difference of multiple sets.
Stores the difference of multiple sets in a key.
Changes the selected database.
Sets the string value of a key, ignoring its type. The key is created if it doesn't exist.
Sets or clears the bit at offset of the string value. Creates the key if it doesn't exist.
Sets the string value and expiration time of a key. Creates the key if it doesn't exist.
Set the string value of a key only when the key doesn't exist.
Overwrites a part of a string value with another by an offset. Creates the key if it doesn't exist.
Synchronously saves the database(s) to disk and shuts down the server.
Returns the intersect of multiple sets.
Returns the number of members of the intersect of multiple sets.
Stores the intersect of multiple sets in a key.
Determines whether a member belongs to a set.
Sets a server as a replica of another, or promotes it to being a primary.
Returns the slow log's entries.
Show helpful text about the different subcommands
Returns the number of entries in the slow log.
Clears all entries from the slow log.
Returns all members of a set.
Determines whether multiple members belong to a set.
Sorts the elements in a list, a set, or a sorted set, optionally storing the result.
Returns the sorted elements of a list, a set, or a sorted set.
Returns one or more random members from a set after removing them. Deletes the set if the last member was popped.
Post a message to a shard channel
Get one or multiple random members from a set
Removes one or more members from a set. Deletes the set if the last member was removed.
Iterates over members of a set.
Listens for messages published to shard channels.
Returns the length of a string value.
Listens for messages published to channels.
Returns a substring from a string value.
Returns the union of multiple sets.
Stores the union of multiple sets in a key.
Stops listening to messages posted to shard channels.
Swaps two databases.
An internal command used in replication.
Returns the server time.
Returns the number of existing keys out of those specified after updating the time they were last accessed.
Returns the expiration time in seconds of a key.
Determines the type of value stored at a key.
Asynchronously deletes one or more keys.
Stops listening to messages posted to channels.
Forgets about watched keys of a transaction.
Blocks until the asynchronous replication of all preceding write commands sent by the connection is completed.
Blocks until all of the preceding write commands sent by the connection are written to the append-only file of the primary and/or replicas.
Monitors changes to keys to determine the execution of a transaction.
Returns the number of messages that were successfully acknowledged by the consumer group member of a stream.
Appends a new message to a stream. Creates the key if it doesn't exist.
Changes, or acquires, ownership of messages in a consumer group, as if the messages were delivered to as consumer group member.
Changes, or acquires, ownership of a message in a consumer group, as if the message was delivered a consumer group member.
Returns the number of messages after removing them from a stream.
Creates a consumer group.
Creates a consumer in a consumer group.
Deletes a consumer from a consumer group.
Destroys a consumer group.
Returns helpful text about the different subcommands.
Sets the last-delivered ID of a consumer group.
Returns a list of the consumers in a consumer group.
Returns a list of the consumer groups of a stream.
Returns helpful text about the different subcommands.
Returns information about a stream.
Return the number of messages in a stream.
Returns the information and entries from a stream consumer group's pending entries list.
Returns the messages from a stream within a range of IDs.
Returns messages from multiple streams with IDs greater than the ones requested. Blocks until a message is available otherwise.
Returns new or historical messages from a stream for a consumer in a group. Blocks until a message is available otherwise.
Returns the messages from a stream within a range of IDs in reverse order.
An internal command for replicating stream values.
Deletes messages from the beginning of a stream.
Adds one or more members to a sorted set, or updates their scores. Creates the key if it doesn't exist.
Returns the number of members in a sorted set.
Returns the count of members in a sorted set that have scores within a range.
Returns the difference between multiple sorted sets.
Stores the difference of multiple sorted sets in a key.
Increments the score of a member in a sorted set.
Returns the intersect of multiple sorted sets.
Returns the number of members of the intersect of multiple sorted sets.
Stores the intersect of multiple sorted sets in a key.
Returns the number of members in a sorted set within a lexicographical range.
Returns the highest- or lowest-scoring members from one or more sorted sets after removing them. Deletes the sorted set if the last member was popped.
Returns the score of one or more members in a sorted set.
Returns the highest-scoring members from a sorted set after removing them. Deletes the sorted set if the last member was popped.
Returns the lowest-scoring members from a sorted set after removing them. Deletes the sorted set if the last member was popped.
Returns one or more random members from a sorted set.
Returns members in a sorted set within a range of indexes.
Returns members in a sorted set within a lexicographical range.
Returns members in a sorted set within a range of scores.
Stores a range of members from sorted set in a key.
Returns the index of a member in a sorted set ordered by ascending scores.
Removes one or more members from a sorted set. Deletes the sorted set if all members were removed.
Removes members in a sorted set within a lexicographical range. Deletes the sorted set if all members were removed.
Removes members in a sorted set within a range of indexes. Deletes the sorted set if all members were removed.
Removes members in a sorted set within a range of scores. Deletes the sorted set if all members were removed.
Returns members in a sorted set within a range of indexes in reverse order.
Returns members in a sorted set within a lexicographical range in reverse order.
Returns members in a sorted set within a range of scores in reverse order.
Returns the index of a member in a sorted set ordered by descending scores.
Iterates over members and scores of a sorted set.
Returns the score of a member in a sorted set.
Returns the union of multiple sorted sets.
Stores the union of multiple sorted sets in a key.
Generated using TypeDoc
Client for the official Redis Cluster